Document help overlay action name in GtkApplication
authorPhillip Wood <phillip.wood@dunelm.org.uk>
Wed, 17 Feb 2016 10:07:02 +0000 (10:07 +0000)
committerPhillip Wood <phillip.wood@dunelm.org.uk>
Thu, 18 Feb 2016 14:11:14 +0000 (14:11 +0000)
This means all the information needed to automatically load a
shortcuts window and create a menu item to show it is in one place.

https://bugzilla.gnome.org/show_bug.cgi?id=761431

gtk/gtkapplication.c

index 3828738d5fc23c88a9d7f49232ffe94d4563f5db..ce023a21abd4d58611877f33c5ac7d9129a7c2d9 100644 (file)
  * resources.  See gtk_icon_theme_add_resource_path() for more
  * information.
  *
- * If there is a resource located at "gtk/help-overlay.ui" which is
- * defining a #GtkShortcutsWindow with ID "help_overlay" then GtkApplication
+ * If there is a resource located at "gtk/help-overlay.ui" which
+ * defines a #GtkShortcutsWindow with ID "help_overlay" then GtkApplication
  * associates an instance of this shortcuts window with each
  * #GtkApplicationWindow and sets up keyboard accelerators (Control-F1
- * and Control-?) to open it.
+ * and Control-?) to open it. To create an menu item that displays the
+ * shortcuts window associate the item with the action win.show-help-overlay.
  *
  * ## A simple application ## {#gtkapplication}
  *